// 版权所有2009年围棋作者。版权所有。
// 此源代码的使用受BSD样式的约束
// 可以在许可证文件中找到的许可证。

// 包列表实现了一个双链接列表。
// None
// 要遍历列表（其中l是*列表），请执行以下操作：
// 对于e:=l.前（）；e！=无e=e.Next（）{
// None
// }
// None
package list

// 元素是链表的元素。
type Element struct {
	// 双链接元素列表中的下一个和上一个指针。
	// 为了简化实现，在内部实现了一个列表l
	// 作为一个环，&l.root是最后一个元素的下一个元素
	// list元素（l.Back（））和第一个列表的前一个元素
	// 元素（l.Front（）。
	next, prev *Element

	// 此元素所属的列表。
	list *List

	// 与此元素一起存储的值。
	Value interface{}
}

// Next返回下一个列表元素或nil。
func (e *Element) Next() *Element {
	if p := e.next; e.list != nil && p != &e.list.root {
		return p
	}
	return nil
}

// Prev返回上一个列表元素或nil。
func (e *Element) Prev() *Element {
	if p := e.prev; e.list != nil && p != &e.list.root {
		return p
	}
	return nil
}

// 列表表示双链接列表。
// 列表的零值是一个空列表，可以使用。
type List struct {
	root Element // sentinel列表元素，仅使用&root、root.prev和root.next
	len  int     // 不包括（此）sentinel元素的当前列表长度
}

// Init初始化或清除列表l。
func (l *List) Init() *List {
	l.root.next = &l.root
	l.root.prev = &l.root
	l.len = 0
	return l
}

// New返回一个初始化的列表。
func New() *List { return new(List).Init() }

// Len返回列表l的元素数。
// 复杂度为O（1）。
func (l *List) Len() int { return l.len }

// Front返回列表l的第一个元素，如果列表为空，则返回nil。
func (l *List) Front() *Element {
	if l.len == 0 {
		return nil
	}
	return l.root.next
}

// Back返回列表l的最后一个元素，如果列表为空，则返回nil。
func (l *List) Back() *Element {
	if l.len == 0 {
		return nil
	}
	return l.root.prev
}

// lazyInit惰性地初始化一个零列表值。
func (l *List) lazyInit() {
	if l.root.next == nil {
		l.Init()
	}
}

// 在at之后插入e，增加l.len，并返回e。
func (l *List) insert(e, at *Element) *Element {
	e.prev = at
	e.next = at.next
	e.prev.next = e
	e.next.prev = e
	e.list = l
	l.len++
	return e
}

// insertValue是insert（&Element{Value:v}，at）的方便包装器。
func (l *List) insertValue(v interface{}, at *Element) *Element {
	return l.insert(&Element{Value: v}, at)
}

// remove从其列表中删除e，递减l.len，并返回e。
func (l *List) remove(e *Element) *Element {
	e.prev.next = e.next
	e.next.prev = e.prev
	e.next = nil // 避免内存泄漏
	e.prev = nil // 避免内存泄漏
	e.list = nil
	l.len--
	return e
}

// move将e移到at旁边并返回e。
func (l *List) move(e, at *Element) *Element {
	if e == at {
		return e
	}
	e.prev.next = e.next
	e.next.prev = e.prev

	e.prev = at
	e.next = at.next
	e.prev.next = e
	e.next.prev = e

	return e
}

// 如果e是列表l的一个元素，则Remove从l中删除e。
// 它返回元素值e.value。
// 元素不能为零。
func (l *List) Remove(e *Element) interface{} {
	if e.list == l {
		// 如果e.list==l，则在插入e时l必须已初始化
		// 在l或l==nil（e是零元素）中，l.remove将崩溃
		l.remove(e)
	}
	return e.Value
}

// PushFront在列表l的前面插入一个值为v的新元素e并返回e。
func (l *List) PushFront(v interface{}) *Element {
	l.lazyInit()
	return l.insertValue(v, &l.root)
}

// PushBack在列表l的后面插入一个值为v的新元素e并返回e。
func (l *List) PushBack(v interface{}) *Element {
	l.lazyInit()
	return l.insertValue(v, l.root.prev)
}

// InsertBefore在标记前插入一个值为v的新元素e，并返回e。
// 如果标记不是l的元素，则不修改列表。
// 分数不能为零。
func (l *List) InsertBefore(v interface{}, mark *Element) *Element {
	if mark.list != l {
		return nil
	}
	// 请参阅列表中的注释。删除关于l的初始化
	return l.insertValue(v, mark.prev)
}

// InsertAfter在标记后立即插入一个值为v的新元素e，并返回e。
// 如果标记不是l的元素，则不修改列表。
// 分数不能为零。
func (l *List) InsertAfter(v interface{}, mark *Element) *Element {
	if mark.list != l {
		return nil
	}
	// 请参阅列表中的注释。删除关于l的初始化
	return l.insertValue(v, mark)
}

// MoveToFront将元素e移动到列表l的前面。
// 如果e不是l的元素，则不修改列表。
// 元素不能为零。
func (l *List) MoveToFront(e *Element) {
	if e.list != l || l.root.next == e {
		return
	}
	// 请参阅列表中的注释。删除关于l的初始化
	l.move(e, &l.root)
}

// MoveToBack将元素e移动到列表l的后面。
// 如果e不是l的元素，则不修改列表。
// 元素不能为零。
func (l *List) MoveToBack(e *Element) {
	if e.list != l || l.root.prev == e {
		return
	}
	// 请参阅列表中的注释。删除关于l的初始化
	l.move(e, l.root.prev)
}

// MoveBefore将元素e移动到标记之前的新位置。
// 如果e或mark不是l的元素，或e==mark，则不修改列表。
// 元素和标记不能为零。
func (l *List) MoveBefore(e, mark *Element) {
	if e.list != l || e == mark || mark.list != l {
		return
	}
	l.move(e, mark.prev)
}

// MoveAfter将元素e移动到标记后的新位置。
// 如果e或mark不是l的元素，或e==mark，则不修改列表。
// 元素和标记不能为零。
func (l *List) MoveAfter(e, mark *Element) {
	if e.list != l || e == mark || mark.list != l {
		return
	}
	l.move(e, mark)
}

// PushBackList在列表l的后面插入另一个列表的副本。
// 列表l和其他列表可能相同。它们不能为零。
func (l *List) PushBackList(other *List) {
	l.lazyInit()
	for i, e := other.Len(), other.Front(); i > 0; i, e = i-1, e.Next() {
		l.insertValue(e.Value, l.root.prev)
	}
}

// PushFrontList在列表l的前面插入另一个列表的副本。
// 列表l和其他列表可能相同。它们不能为零。
func (l *List) PushFrontList(other *List) {
	l.lazyInit()
	for i, e := other.Len(), other.Back(); i > 0; i, e = i-1, e.Prev() {
		l.insertValue(e.Value, &l.root)
	}
}
